Fix Pylint Errors in Dev #2669

IsaacMilarky · 2024-01-23T16:18:31Z

Description

Added module doc-strings to data_parse.py
Removed unneeded parameters from various methods
Removed unused variables
Fixed some minor import issues
Document GitLab task structures
Add linting compliance to various files

Signed commits

Yes, I signed my commits.

Signed-off-by: Isaac Milarsky <[email protected]>

augur/api/view/routes.py

github-actions · 2024-01-23T16:19:19Z

augur/api/view/routes.py

@@ -1,4 +1,5 @@
 import logging
+import math
 from flask import Flask, render_template, render_template_string, request, abort, jsonify, redirect, url_for, session, flash
 from sqlalchemy.orm.exc import NoResultFound
 from .utils import *


[pylint] _{reported by reviewdog 🐶}
E0402: Attempted relative import beyond top-level package (relative-beyond-top-level)

github-actions · 2024-01-23T16:19:19Z

augur/api/view/routes.py

@@ -1,4 +1,5 @@
 import logging
+import math
 from flask import Flask, render_template, render_template_string, request, abort, jsonify, redirect, url_for, session, flash
 from sqlalchemy.orm.exc import NoResultFound
 from .utils import *


[pylint] _{reported by reviewdog 🐶}
W0401: Wildcard import utils (wildcard-import)

augur/api/view/utils.py

github-actions · 2024-01-23T16:19:19Z

augur/api/view/utils.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from concurrent.futures import ThreadPoolExecutor
 from flask import render_template, flash, url_for, Flask
+from .init import init_logging


[pylint] _{reported by reviewdog 🐶}
E0402: Attempted relative import beyond top-level package (relative-beyond-top-level)

github-actions · 2024-01-23T16:19:19Z

augur/api/view/utils.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from concurrent.futures import ThreadPoolExecutor
 from flask import render_template, flash, url_for, Flask
+from .init import init_logging
 from .init import *


[pylint] _{reported by reviewdog 🐶}
E0402: Attempted relative import beyond top-level package (relative-beyond-top-level)

github-actions · 2024-01-23T16:19:19Z

augur/api/view/utils.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from concurrent.futures import ThreadPoolExecutor
 from flask import render_template, flash, url_for, Flask
+from .init import init_logging
 from .init import *


[pylint] _{reported by reviewdog 🐶}
W0401: Wildcard import init (wildcard-import)

github-actions · 2024-01-23T16:19:19Z

augur/api/view/utils.py

@@ -1,6 +1,7 @@
 from pathlib import Path
 from concurrent.futures import ThreadPoolExecutor
 from flask import render_template, flash, url_for, Flask
+from .init import init_logging
 from .init import *
 from ..server import app, db_session


[pylint] _{reported by reviewdog 🐶}
E0402: Attempted relative import beyond top-level package (relative-beyond-top-level)

Signed-off-by: Isaac Milarsky <[email protected]>

github-actions · 2024-01-23T17:26:38Z

augur/tasks/github/pull_requests/tasks.py

@@ -76,7 +76,16 @@ def retrieve_all_pr_data(repo_git: str, logger, key_auth) -> None:


 def process_pull_requests(pull_requests, task_name, repo_id, logger, augur_db):


[pylint] _{reported by reviewdog 🐶}
R0914: Too many local variables (32/30) (too-many-locals)

Signed-off-by: Isaac Milarsky <[email protected]>

github-actions · 2024-01-23T17:44:36Z

augur/tasks/github/util/util.py

+    Returns:
+        Sum of issues and prs for that repo
+    """
+
    from augur.tasks.github.util.gh_graphql_entities import GitHubRepo as GitHubRepoGraphql


[pylint] _{reported by reviewdog 🐶}
C0415: Import outside toplevel (augur.tasks.github.util.gh_graphql_entities.GitHubRepo) (import-outside-toplevel)

Signed-off-by: Isaac Milarsky <[email protected]>

github-actions · 2024-01-23T17:48:16Z

augur/api/view/routes.py

@@ -37,9 +41,9 @@ def root(path=""):
 def logo(brand=None):


[pylint] _{reported by reviewdog 🐶}
C0116: Missing function or method docstring (missing-function-docstring)

Signed-off-by: Isaac Milarsky <[email protected]>

github-actions · 2024-01-23T18:23:45Z

augur/tasks/gitlab/gitlab_random_key_auth.py

@@ -6,8 +6,8 @@


 class GitlabRandomKeyAuth(RandomKeyAuth):


[pylint] _{reported by reviewdog 🐶}
R0903: Too few public methods (1/2) (too-few-public-methods)

github-actions · 2024-01-23T18:23:45Z

augur/tasks/gitlab/gitlab_task_session.py

+        key_auth: GitLab specific key auth retrieval collection
+        logger: logging object
+        platform_id: GitLab specific platform id (github is 1)
+    """

    def __init__(self, logger):

        from augur.tasks.init.celery_app import engine


[pylint] _{reported by reviewdog 🐶}
C0415: Import outside toplevel (augur.tasks.init.celery_app.engine) (import-outside-toplevel)

github-actions · 2024-01-23T18:23:45Z

augur/tasks/gitlab/issues_task.py

@@ -73,7 +89,17 @@ def retrieve_all_gitlab_issue_data(repo_git, logger, key_auth) -> None:
    return all_data

 def process_issues(issues, task_name, repo_id, logger, augur_db) -> None:


[pylint] _{reported by reviewdog 🐶}
R1710: Either all return statements in a function should return an expression, or none of them should. (inconsistent-return-statements)

github-actions · 2024-01-23T18:23:45Z

augur/tasks/gitlab/issues_task.py

@@ -186,7 +228,7 @@ def retrieve_all_gitlab_issue_comments(key_auth, logger, issue_ids, repo_git):

    for id in issue_ids:


[pylint] _{reported by reviewdog 🐶}
W0622: Redefining built-in 'id' (redefined-builtin)

github-actions · 2024-01-23T18:23:45Z

augur/tasks/gitlab/merge_request_task.py

@@ -283,6 +351,16 @@ def collect_merge_request_reviewers(mr_ids, repo_git) -> int:
            logger.info(f"{owner}/{repo} has no gitlab merge request reviewers")

 def process_mr_reviewers(data, task_name, repo_id, logger, augur_db):


[pylint] _{reported by reviewdog 🐶}
W0613: Unused argument 'task_name' (unused-argument)

github-actions · 2024-01-23T18:23:45Z

augur/tasks/gitlab/merge_request_task.py

@@ -283,6 +351,16 @@ def collect_merge_request_reviewers(mr_ids, repo_git) -> int:
            logger.info(f"{owner}/{repo} has no gitlab merge request reviewers")

 def process_mr_reviewers(data, task_name, repo_id, logger, augur_db):


[pylint] _{reported by reviewdog 🐶}
W0613: Unused argument 'logger' (unused-argument)

Signed-off-by: Isaac Milarsky <[email protected]>

github-actions · 2024-01-23T18:27:25Z

augur/tasks/gitlab/merge_request_task.py

        else:
            logger.info(f"{owner}/{repo} has no gitlab merge request reviewers")

-def process_mr_reviewers(data, task_name, repo_id, logger, augur_db):
+def process_mr_reviewers(data, repo_id, logger, augur_db):


[pylint] _{reported by reviewdog 🐶}
W0613: Unused argument 'logger' (unused-argument)

Signed-off-by: Isaac Milarsky <[email protected]>

address linting errors in data_parse.py

9ab76e7

Signed-off-by: Isaac Milarsky <[email protected]>

IsaacMilarky changed the base branch from main to dev January 23, 2024 16:18